home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 February: Tool Chest / Apple Developer CD Series Tool Chest February 1996 (Apple Computer)(1996).iso / Tool Chest / Interfaces & Libraries / Interfaces / PInterfaces / Devices.p < prev    next >
Encoding:
Text File  |  1995-07-06  |  13.3 KB  |  411 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        Devices.p
  3.  
  4.      Contains:    Device Manager Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Package:    Universal Interfaces 2.1 in “MPW Latest” on ETO #18
  8.  
  9.      Copyright:    © 1984-1995 by Apple Computer, Inc.
  10.                  All rights reserved.
  11.  
  12.      Bugs?:        If you find a problem with this file, use the Apple Bug Reporter
  13.                  stack.  Include the file and version information (from above)
  14.                  in the problem description and send to:
  15.                      Internet:    apple.bugs@applelink.apple.com
  16.                      AppleLink:    APPLE.BUGS
  17.  
  18. }
  19.  
  20. {$IFC UNDEFINED UsingIncludes}
  21. {$SETC UsingIncludes := 0}
  22. {$ENDC}
  23.  
  24. {$IFC NOT UsingIncludes}
  25.  UNIT Devices;
  26.  INTERFACE
  27. {$ENDC}
  28.  
  29. {$IFC UNDEFINED __DEVICES__}
  30. {$SETC __DEVICES__ := 1}
  31.  
  32. {$I+}
  33. {$SETC DevicesIncludes := UsingIncludes}
  34. {$SETC UsingIncludes := 1}
  35.  
  36.  
  37. {$IFC UNDEFINED __OSUTILS__}
  38. {$I OSUtils.p}
  39. {$ENDC}
  40. {    Types.p                                                        }
  41. {        ConditionalMacros.p                                        }
  42. {    MixedMode.p                                                    }
  43. {    Memory.p                                                    }
  44.  
  45. {$IFC UNDEFINED __FILES__}
  46. {$I Files.p}
  47. {$ENDC}
  48. {    Finder.p                                                    }
  49.  
  50. {$IFC UNDEFINED __QUICKDRAW__}
  51. {$I Quickdraw.p}
  52. {$ENDC}
  53. {    QuickdrawText.p                                                }
  54.  
  55. {$IFC UNDEFINED __EVENTS__}
  56. {$I Events.p}
  57. {$ENDC}
  58.  
  59. {$IFC UNDEFINED __DIALOGS__}
  60. {$I Dialogs.p}
  61. {$ENDC}
  62. {    Errors.p                                                    }
  63. {    Menus.p                                                        }
  64. {    Controls.p                                                    }
  65. {    Windows.p                                                    }
  66. {    TextEdit.p                                                    }
  67.  
  68. {$PUSH}
  69. {$ALIGN MAC68K}
  70. {$LibExport+}
  71.  
  72. CONST
  73.     chooserInitMsg                = 11;                            { the user selected this device package }
  74.     newSelMsg                    = 12;                            { the user made new device selections }
  75.     fillListMsg                    = 13;                            { fill the device list with choices }
  76.     getSelMsg                    = 14;                            { mark one or more choices as selected }
  77.     selectMsg                    = 15;                            { the user made a selection }
  78.     deselectMsg                    = 16;                            { the user canceled a selection }
  79.     terminateMsg                = 17;                            { allows device package to clean up }
  80.     buttonMsg                    = 19;                            { the user selected a button }
  81.  
  82. { Values of the 'caller' parameter to a Chooser device package }
  83.     chooserID                    = 1;
  84.  
  85. { Values of the 'message' parameter to a Control Panel 'cdev' }
  86.     initDev                        = 0;                            {Time for cdev to initialize itself}
  87.     hitDev                        = 1;                            {Hit on one of my items}
  88.     closeDev                    = 2;                            {Close yourself}
  89.     nulDev                        = 3;                            {Null event}
  90.     updateDev                    = 4;                            {Update event}
  91.     activDev                    = 5;                            {Activate event}
  92.     deactivDev                    = 6;                            {Deactivate event}
  93.     keyEvtDev                    = 7;                            {Key down/auto key}
  94.     macDev                        = 8;                            {Decide whether or not to show up}
  95.     undoDev                        = 9;
  96.     cutDev                        = 10;
  97.     copyDev                        = 11;
  98.     pasteDev                    = 12;
  99.     clearDev                    = 13;
  100.     cursorDev                    = 14;
  101.  
  102. { Special values a Control Panel 'cdev' can return }
  103.     cdevGenErr                    = -1;                            {General error; gray cdev w/o alert}
  104.     cdevMemErr                    = 0;                            {Memory shortfall; alert user please}
  105.     cdevResErr                    = 1;                            {Couldn't get a needed resource; alert}
  106.     cdevUnset                    = 3;                            { cdevValue is initialized to this}
  107.  
  108. { Values of the 'message' parameter to a Monitor 'mntr' }
  109.     initMsg                        = 1;                            {initialization}
  110.     okMsg                        = 2;                            {user clicked OK button}
  111.     cancelMsg                    = 3;                            {user clicked Cancel button}
  112.     hitMsg                        = 4;                            {user clicked control in Options dialog}
  113.     nulMsg                        = 5;                            {periodic event}
  114.     updateMsg                    = 6;                            {update event}
  115.     activateMsg                    = 7;                            {not used}
  116.     deactivateMsg                = 8;                            {not used}
  117.     keyEvtMsg                    = 9;                            {keyboard event}
  118.     superMsg                    = 10;                            {show superuser controls}
  119.     normalMsg                    = 11;                            {show only normal controls}
  120.     startupMsg                    = 12;                            {code has been loaded}
  121.  
  122. { control codes for DeskAccessories }
  123.     goodbye                        = -1;                            { heap being reinitialized }
  124.     killCode                    = 1;                            { KillIO requested }
  125.     accEvent                    = 64;                            { handle an event }
  126.     accRun                        = 65;                            { time for periodic action }
  127.     accCursor                    = 66;                            { change cursor shape }
  128.     accMenu                        = 67;                            { handle menu item }
  129.     accUndo                        = 68;                            { handle undo command }
  130.     accCut                        = 70;                            { handle cut command }
  131.     accCopy                        = 71;                            { handle copy command }
  132.     accPaste                    = 72;                            { handle paste command }
  133.     accClear                    = 73;                            { handle clear command }
  134.  
  135. { Control/Status Call Codes }
  136.     drvStsCode                    = 8;                            { status call code for drive status }
  137.     ejectCode                    = 7;                            { control call eject code }
  138.     tgBuffCode                    = 8;                            { set tag buffer code }
  139.  
  140. { miscellaneous Device Manager constants }
  141.     ioInProgress                = 1;                            { predefined value of ioResult while I/O is pending }
  142.     aRdCmd                        = 2;                            { low byte of ioTrap for Read calls }
  143.     aWrCmd                        = 3;                            { low byte of ioTrap for Write calls }
  144.     asyncTrpBit                    = 10;                            { trap word modifier }
  145.     noQueueBit                    = 9;                            { trap word modifier }
  146.  
  147. { flags used in the driver header and device control entry }
  148.     dReadEnable                    = 0;                            { set if driver responds to read requests }
  149.     dWritEnable                    = 1;                            { set if driver responds to write requests }
  150.     dCtlEnable                    = 2;                            { set if driver responds to control requests }
  151.     dStatEnable                    = 3;                            { set if driver responds to status requests }
  152.     dNeedGoodBye                = 4;                            { set if driver needs time for performing periodic tasks }
  153.     dNeedTime                    = 5;                            { set if driver needs time for performing periodic tasks }
  154.     dNeedLock                    = 6;                            { set if driver must be locked in memory as soon as it is opened }
  155.     dNeedLockMask                = $4000;                        { set if driver must be locked in memory as soon as it is opened }
  156.     dNeedTimeMask                = $2000;                        { set if driver needs time for performing periodic tasks }
  157.     dNeedGoodByeMask            = $1000;                        { set if driver needs to be called before the application heap is initialized }
  158.     dStatEnableMask                = $0800;                        { set if driver responds to status requests }
  159.     dCtlEnableMask                = $0400;                        { set if driver responds to control requests }
  160.     dWritEnableMask                = $0200;                        { set if driver responds to write requests }
  161.     dReadEnableMask                = $0100;                        { set if driver responds to read requests }
  162.  
  163. { run-time flags used in the device control entry }
  164.     dOpened                        = 5;                            { driver is open }
  165.     dRAMBased                    = 6;                            { dCtlDriver is a handle (1) or pointer (0) }
  166.     drvrActive                    = 7;                            { driver is currently processing a request }
  167.     drvrActiveMask                = $0080;                        { driver is currently processing a request }
  168.     dRAMBasedMask                = $0040;                        { dCtlDriver is a handle (1) or pointer (0) }
  169.     dOpenedMask                    = $0020;                        { driver is open }
  170.  
  171.  
  172. TYPE
  173.     DRVRHeader = RECORD
  174.         drvrFlags:                INTEGER;
  175.         drvrDelay:                INTEGER;
  176.         drvrEMask:                INTEGER;
  177.         drvrMenu:                INTEGER;
  178.         drvrOpen:                INTEGER;
  179.         drvrPrime:                INTEGER;
  180.         drvrCtl:                INTEGER;
  181.         drvrStatus:                INTEGER;
  182.         drvrClose:                INTEGER;
  183.         drvrName:                ARRAY [0..0] OF SInt8; (* unsigned char *)
  184.     END;
  185.  
  186.     DRVRHeaderPtr = ^DRVRHeader;
  187.     DRVRHeaderHandle = ^DRVRHeaderPtr;
  188.  
  189.     DCtlEntry = RECORD
  190.         dCtlDriver:                Ptr;
  191.         dCtlFlags:                INTEGER;
  192.         dCtlQHdr:                QHdr;
  193.         dCtlPosition:            LONGINT;
  194.         dCtlStorage:            Handle;
  195.         dCtlRefNum:                INTEGER;
  196.         dCtlCurTicks:            LONGINT;
  197.         dCtlWindow:                WindowPtr;
  198.         dCtlDelay:                INTEGER;
  199.         dCtlEMask:                INTEGER;
  200.         dCtlMenu:                INTEGER;
  201.     END;
  202.  
  203.     DCtlPtr = ^DCtlEntry;
  204.     DCtlHandle = ^DCtlPtr;
  205.  
  206.     AuxDCE = PACKED RECORD
  207.         dCtlDriver:                Ptr;
  208.         dCtlFlags:                INTEGER;
  209.         dCtlQHdr:                QHdr;
  210.         dCtlPosition:            LONGINT;
  211.         dCtlStorage:            Handle;
  212.         dCtlRefNum:                INTEGER;
  213.         dCtlCurTicks:            LONGINT;
  214.         dCtlWindow:                GrafPtr;
  215.         dCtlDelay:                INTEGER;
  216.         dCtlEMask:                INTEGER;
  217.         dCtlMenu:                INTEGER;
  218.         dCtlSlot:                SInt8;
  219.         dCtlSlotId:                SInt8;
  220.         dCtlDevBase:            LONGINT;
  221.         dCtlOwner:                Ptr;
  222.         dCtlExtDev:                SInt8;
  223.         fillByte:                SInt8;
  224.         dCtlNodeID:                UInt32;
  225.     END;
  226.  
  227.     AuxDCEPtr = ^AuxDCE;
  228.     AuxDCEHandle = ^AuxDCEPtr;
  229.  
  230. {$IFC NOT OLDROUTINELOCATIONS }
  231.  
  232. FUNCTION PBOpenSync(paramBlock: ParmBlkPtr): OSErr;
  233.     {$IFC NOT GENERATINGCFM}
  234.     INLINE $205F, $A000, $3E80;
  235.     {$ENDC}
  236. FUNCTION PBOpenAsync(paramBlock: ParmBlkPtr): OSErr;
  237.     {$IFC NOT GENERATINGCFM}
  238.     INLINE $205F, $A400, $3E80;
  239.     {$ENDC}
  240. FUNCTION PBOpenImmed(paramBlock: ParmBlkPtr): OSErr;
  241.     {$IFC NOT GENERATINGCFM}
  242.     INLINE $205F, $A200, $3E80;
  243.     {$ENDC}
  244. FUNCTION PBCloseSync(paramBlock: ParmBlkPtr): OSErr;
  245.     {$IFC NOT GENERATINGCFM}
  246.     INLINE $205F, $A001, $3E80;
  247.     {$ENDC}
  248. FUNCTION PBCloseAsync(paramBlock: ParmBlkPtr): OSErr;
  249.     {$IFC NOT GENERATINGCFM}
  250.     INLINE $205F, $A401, $3E80;
  251.     {$ENDC}
  252. FUNCTION PBCloseImmed(paramBlock: ParmBlkPtr): OSErr;
  253.     {$IFC NOT GENERATINGCFM}
  254.     INLINE $205F, $A201, $3E80;
  255.     {$ENDC}
  256. FUNCTION PBReadSync(paramBlock: ParmBlkPtr): OSErr;
  257.     {$IFC NOT GENERATINGCFM}
  258.     INLINE $205F, $A002, $3E80;
  259.     {$ENDC}
  260. FUNCTION PBReadAsync(paramBlock: ParmBlkPtr): OSErr;
  261.     {$IFC NOT GENERATINGCFM}
  262.     INLINE $205F, $A402, $3E80;
  263.     {$ENDC}
  264. FUNCTION PBReadImmed(paramBlock: ParmBlkPtr): OSErr;
  265.     {$IFC NOT GENERATINGCFM}
  266.     INLINE $205F, $A202, $3E80;
  267.     {$ENDC}
  268. FUNCTION PBWriteSync(paramBlock: ParmBlkPtr): OSErr;
  269.     {$IFC NOT GENERATINGCFM}
  270.     INLINE $205F, $A003, $3E80;
  271.     {$ENDC}
  272. FUNCTION PBWriteAsync(paramBlock: ParmBlkPtr): OSErr;
  273.     {$IFC NOT GENERATINGCFM}
  274.     INLINE $205F, $A403, $3E80;
  275.     {$ENDC}
  276. FUNCTION PBWriteImmed(paramBlock: ParmBlkPtr): OSErr;
  277.     {$IFC NOT GENERATINGCFM}
  278.     INLINE $205F, $A203, $3E80;
  279.     {$ENDC}
  280. PROCEDURE AddDrive(drvrRefNum: INTEGER; drvNum: INTEGER; qEl: DrvQElPtr);
  281. FUNCTION GetDrvQHdr: QHdrPtr;
  282.     {$IFC NOT GENERATINGCFM}
  283.     INLINE $2EBC, $0000, $0308;
  284.     {$ENDC}
  285. {$ENDC}
  286. { Control Panel Default Proc }
  287. TYPE
  288.     ControlPanelDefProcPtr = ProcPtr;  { FUNCTION ControlPanelDef(message: INTEGER; item: INTEGER; numItems: INTEGER; cPanelID: INTEGER; VAR theEvent: EventRecord; cdevValue: LONGINT; cpDialog: DialogPtr): LONGINT; }
  289.     ControlPanelDefUPP = UniversalProcPtr;
  290.  
  291. CONST
  292.     uppControlPanelDefProcInfo = $000FEAB0; { FUNCTION (2 byte param, 2 byte param, 2 byte param, 2 byte param, 4 byte param, 4 byte param, 4 byte param): 4 byte result; }
  293.  
  294. FUNCTION NewControlPanelDefProc(userRoutine: ControlPanelDefProcPtr): ControlPanelDefUPP;
  295.     {$IFC NOT GENERATINGCFM }
  296.     INLINE $2E9F;
  297.     {$ENDC}
  298.  
  299. FUNCTION CallControlPanelDefProc(message: INTEGER; item: INTEGER; numItems: INTEGER; cPanelID: INTEGER; VAR theEvent: EventRecord; cdevValue: LONGINT; cpDialog: DialogPtr; userRoutine: ControlPanelDefUPP): LONGINT;
  300.     {$IFC NOT GENERATINGCFM}
  301.     INLINE $205F, $4E90;
  302.     {$ENDC}
  303.  
  304. FUNCTION GetDCtlEntry(refNum: INTEGER): DCtlHandle;
  305. {
  306.     SetChooserAlert used to simply set a bit in a low-mem global
  307.     to tell the Chooser not to display its warning message when
  308.     the printer is changed. However, under MultiFinder and System 7,
  309.     this low-mem is swapped out when a layer change occurs, and the
  310.     Chooser never sees the change. It is obsolete, and completely
  311.     unsupported on the PowerPC. 68K apps can still call it if they
  312.     wish.
  313. }
  314. {$IFC OLDROUTINENAMES  & NOT GENERATINGCFM }
  315. FUNCTION SetChooserAlert(f: BOOLEAN): BOOLEAN;
  316. {$ENDC}
  317. {
  318.   Note: DrvrInstall() is no longer supported, becuase it never really worked anyways.
  319.           There will soon be a DriverInstall() which does the right thing.
  320.  
  321.         DrvrRemove has been renamed to DriverRemove.  But, InterfaceLib for PowerPC
  322.         still exports DrvrRemove, so a macro is used to map the new name to old.
  323.  
  324. }
  325. FUNCTION DrvrRemove(refNum: INTEGER): OSErr;
  326.     {$IFC NOT GENERATINGCFM}
  327.     INLINE $301F, $A03E, $3E80;
  328.     {$ENDC}
  329. {$IFC GENERATING68K }
  330. FUNCTION DriverRemove(refNum: INTEGER): OSErr;
  331.     {$IFC NOT GENERATINGCFM}
  332.     INLINE $301F, $A03E, $3E80;
  333.     {$ENDC}
  334. {$ENDC}
  335. FUNCTION OpenDriver(name: ConstStr255Param; VAR drvrRefNum: INTEGER): OSErr;
  336. FUNCTION CloseDriver(refNum: INTEGER): OSErr;
  337. FUNCTION Control(refNum: INTEGER; csCode: INTEGER; csParamPtr: UNIV Ptr): OSErr;
  338. FUNCTION Status(refNum: INTEGER; csCode: INTEGER; csParamPtr: UNIV Ptr): OSErr;
  339. FUNCTION KillIO(refNum: INTEGER): OSErr;
  340. FUNCTION PBControlSync(paramBlock: ParmBlkPtr): OSErr;
  341.     {$IFC NOT GENERATINGCFM}
  342.     INLINE $205F, $A004, $3E80;
  343.     {$ENDC}
  344. FUNCTION PBControlAsync(paramBlock: ParmBlkPtr): OSErr;
  345.     {$IFC NOT GENERATINGCFM}
  346.     INLINE $205F, $A404, $3E80;
  347.     {$ENDC}
  348. FUNCTION PBControlImmed(paramBlock: ParmBlkPtr): OSErr;
  349.     {$IFC NOT GENERATINGCFM}
  350.     INLINE $205F, $A204, $3E80;
  351.     {$ENDC}
  352. FUNCTION PBStatusSync(paramBlock: ParmBlkPtr): OSErr;
  353.     {$IFC NOT GENERATINGCFM}
  354.     INLINE $205F, $A005, $3E80;
  355.     {$ENDC}
  356. FUNCTION PBStatusAsync(paramBlock: ParmBlkPtr): OSErr;
  357.     {$IFC NOT GENERATINGCFM}
  358.     INLINE $205F, $A405, $3E80;
  359.     {$ENDC}
  360. FUNCTION PBStatusImmed(paramBlock: ParmBlkPtr): OSErr;
  361.     {$IFC NOT GENERATINGCFM}
  362.     INLINE $205F, $A205, $3E80;
  363.     {$ENDC}
  364. FUNCTION PBKillIOSync(paramBlock: ParmBlkPtr): OSErr;
  365.     {$IFC NOT GENERATINGCFM}
  366.     INLINE $205F, $A006, $3E80;
  367.     {$ENDC}
  368. FUNCTION PBKillIOAsync(paramBlock: ParmBlkPtr): OSErr;
  369.     {$IFC NOT GENERATINGCFM}
  370.     INLINE $205F, $A406, $3E80;
  371.     {$ENDC}
  372. FUNCTION PBKillIOImmed(paramBlock: ParmBlkPtr): OSErr;
  373.     {$IFC NOT GENERATINGCFM}
  374.     INLINE $205F, $A206, $3E80;
  375.     {$ENDC}
  376. FUNCTION OpenDeskAcc(deskAccName: ConstStr255Param): INTEGER;
  377.     {$IFC NOT GENERATINGCFM}
  378.     INLINE $A9B6;
  379.     {$ENDC}
  380. PROCEDURE CloseDeskAcc(refNum: INTEGER);
  381.     {$IFC NOT GENERATINGCFM}
  382.     INLINE $A9B7;
  383.     {$ENDC}
  384. {$IFC OLDROUTINENAMES }
  385. {
  386.     The PBxxx() routines are obsolete.  
  387.     
  388.     Use the PBxxxSync(), PBxxxAsync(), or PBxxxImmed version instead.
  389. }
  390. FUNCTION PBControl(paramBlock: ParmBlkPtr; async: BOOLEAN): OSErr;
  391. FUNCTION PBStatus(paramBlock: ParmBlkPtr; async: BOOLEAN): OSErr;
  392. FUNCTION PBKillIO(paramBlock: ParmBlkPtr; async: BOOLEAN): OSErr;
  393. {$IFC NOT OLDROUTINELOCATIONS }
  394. FUNCTION PBOpen(paramBlock: ParmBlkPtr; async: BOOLEAN): OSErr;
  395. FUNCTION PBClose(paramBlock: ParmBlkPtr; async: BOOLEAN): OSErr;
  396. FUNCTION PBRead(paramBlock: ParmBlkPtr; async: BOOLEAN): OSErr;
  397. FUNCTION PBWrite(paramBlock: ParmBlkPtr; async: BOOLEAN): OSErr;
  398. {$ENDC}
  399. {$ENDC}
  400.  
  401. {$ALIGN RESET}
  402. {$POP}
  403.  
  404. {$SETC UsingIncludes := DevicesIncludes}
  405.  
  406. {$ENDC} {__DEVICES__}
  407.  
  408. {$IFC NOT UsingIncludes}
  409.  END.
  410. {$ENDC}
  411.